<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>pyactivemq.BytesMessage</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="pyactivemq-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

      <th class="navbar" width="100%"></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="pyactivemq-module.html">Module&nbsp;pyactivemq</a> ::
        Class&nbsp;BytesMessage
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="pyactivemq.BytesMessage-class.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class BytesMessage</h1><p class="nomargin-top"></p>
<pre class="base-tree">
 object --+        
          |        
??.instance --+    
              |    
        <a href="pyactivemq.Message-class.html">Message</a> --+
                  |
                 <strong class="uidshort">BytesMessage</strong>
</pre>

<hr />
<p>A message used for sending a stream of uninterpreted bytes.</p>

<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Instance Methods</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-InstanceMethods"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="pyactivemq.BytesMessage-class.html#readBoolean" class="summary-sig-name">readBoolean</a>(<span class="summary-sig-arg">...</span>)</span><br />
      Reads a boolean from the bytes message stream.</td>
          <td align="right" valign="top">
            
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="pyactivemq.BytesMessage-class.html#readByte" class="summary-sig-name">readByte</a>(<span class="summary-sig-arg">...</span>)</span><br />
      Reads a byte from the bytes message stream.</td>
          <td align="right" valign="top">
            
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="pyactivemq.BytesMessage-class.html#readBytes" class="summary-sig-name">readBytes</a>(<span class="summary-sig-arg">...</span>)</span><br />
      Reads a byte array from the bytes message stream.</td>
          <td align="right" valign="top">
            
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="pyactivemq.BytesMessage-class.html#readChar" class="summary-sig-name">readChar</a>(<span class="summary-sig-arg">...</span>)</span><br />
      Reads a char from the bytes message stream.</td>
          <td align="right" valign="top">
            
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="pyactivemq.BytesMessage-class.html#readDouble" class="summary-sig-name">readDouble</a>(<span class="summary-sig-arg">...</span>)</span><br />
      Reads a 64 bit double from the bytes message stream.</td>
          <td align="right" valign="top">
            
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="pyactivemq.BytesMessage-class.html#readFloat" class="summary-sig-name">readFloat</a>(<span class="summary-sig-arg">...</span>)</span><br />
      Reads a 32 bit float from the bytes message stream.</td>
          <td align="right" valign="top">
            
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="pyactivemq.BytesMessage-class.html#readInt" class="summary-sig-name">readInt</a>(<span class="summary-sig-arg">...</span>)</span><br />
      Reads a 32 bit signed integer from the bytes message stream.</td>
          <td align="right" valign="top">
            
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="pyactivemq.BytesMessage-class.html#readLong" class="summary-sig-name">readLong</a>(<span class="summary-sig-arg">...</span>)</span><br />
      Reads a 64 bit long from the bytes message stream.</td>
          <td align="right" valign="top">
            
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="pyactivemq.BytesMessage-class.html#readShort" class="summary-sig-name">readShort</a>(<span class="summary-sig-arg">...</span>)</span><br />
      Reads a 16 bit signed short from the bytes message stream.</td>
          <td align="right" valign="top">
            
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="pyactivemq.BytesMessage-class.html#readString" class="summary-sig-name">readString</a>(<span class="summary-sig-arg">...</span>)</span><br />
      Reads an ASCII string from the bytes message stream.</td>
          <td align="right" valign="top">
            
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="pyactivemq.BytesMessage-class.html#readUTF" class="summary-sig-name">readUTF</a>(<span class="summary-sig-arg">...</span>)</span><br />
      Reads an UTF string from the bytes message stream.</td>
          <td align="right" valign="top">
            
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="pyactivemq.BytesMessage-class.html#readUnsignedShort" class="summary-sig-name">readUnsignedShort</a>(<span class="summary-sig-arg">...</span>)</span><br />
      Reads a 16 bit unsigned short from the bytes message stream.</td>
          <td align="right" valign="top">
            
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="pyactivemq.BytesMessage-class.html#reset" class="summary-sig-name">reset</a>(<span class="summary-sig-arg">...</span>)</span><br />
      Puts the message body in read-only mode and repositions the stream of bytes to the beginning.</td>
          <td align="right" valign="top">
            
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="pyactivemq.BytesMessage-class.html#writeBoolean" class="summary-sig-name">writeBoolean</a>(<span class="summary-sig-arg">...</span>)</span><br />
      Writes a boolean to the bytes message stream as a 1-byte value.</td>
          <td align="right" valign="top">
            
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="pyactivemq.BytesMessage-class.html#writeByte" class="summary-sig-name">writeByte</a>(<span class="summary-sig-arg">...</span>)</span><br />
      Writes a byte to the bytes message stream as a 1-byte value.</td>
          <td align="right" valign="top">
            
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="pyactivemq.BytesMessage-class.html#writeBytes" class="summary-sig-name">writeBytes</a>(<span class="summary-sig-arg">...</span>)</span><br />
      Writes a byte array to the bytes message stream using the vector size as the number of bytes to write.</td>
          <td align="right" valign="top">
            
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="pyactivemq.BytesMessage-class.html#writeChar" class="summary-sig-name">writeChar</a>(<span class="summary-sig-arg">...</span>)</span><br />
      Writes a char to the bytes message stream as a 1-byte value.</td>
          <td align="right" valign="top">
            
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="pyactivemq.BytesMessage-class.html#writeDouble" class="summary-sig-name">writeDouble</a>(<span class="summary-sig-arg">...</span>)</span><br />
      Writes a double to the bytes message stream as a 8-byte value.</td>
          <td align="right" valign="top">
            
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="pyactivemq.BytesMessage-class.html#writeFloat" class="summary-sig-name">writeFloat</a>(<span class="summary-sig-arg">...</span>)</span><br />
      Writes a float to the bytes message stream as a 4-byte value.</td>
          <td align="right" valign="top">
            
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="pyactivemq.BytesMessage-class.html#writeInt" class="summary-sig-name">writeInt</a>(<span class="summary-sig-arg">...</span>)</span><br />
      Writes a signed integer to the bytes message stream as a 4-byte value.</td>
          <td align="right" valign="top">
            
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="pyactivemq.BytesMessage-class.html#writeLong" class="summary-sig-name">writeLong</a>(<span class="summary-sig-arg">...</span>)</span><br />
      Writes a long to the bytes message stream as a 8-byte value.</td>
          <td align="right" valign="top">
            
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="pyactivemq.BytesMessage-class.html#writeShort" class="summary-sig-name">writeShort</a>(<span class="summary-sig-arg">...</span>)</span><br />
      Writes a signed short to the bytes message stream as a 2-byte value.</td>
          <td align="right" valign="top">
            
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="pyactivemq.BytesMessage-class.html#writeString" class="summary-sig-name">writeString</a>(<span class="summary-sig-arg">...</span>)</span><br />
      Writes an ASCII string to the bytes message stream.</td>
          <td align="right" valign="top">
            
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="pyactivemq.BytesMessage-class.html#writeUTF" class="summary-sig-name">writeUTF</a>(<span class="summary-sig-arg">...</span>)</span><br />
      Writes an UTF string to the bytes message stream.</td>
          <td align="right" valign="top">
            
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="pyactivemq.BytesMessage-class.html#writeUnsignedShort" class="summary-sig-name">writeUnsignedShort</a>(<span class="summary-sig-arg">...</span>)</span><br />
      Writes a unsigned short to the bytes message stream as a 2-byte value.</td>
          <td align="right" valign="top">
            
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="pyactivemq.Message-class.html">Message</a></code></b>:
      <code><a href="pyactivemq.Message-class.html#__init__">__init__</a></code>,
      <code><a href="pyactivemq.Message-class.html#acknowledge">acknowledge</a></code>,
      <code><a href="pyactivemq.Message-class.html#clearBody">clearBody</a></code>,
      <code><a href="pyactivemq.Message-class.html#clearProperties">clearProperties</a></code>,
      <code><a href="pyactivemq.Message-class.html#getBooleanProperty">getBooleanProperty</a></code>,
      <code><a href="pyactivemq.Message-class.html#getByteProperty">getByteProperty</a></code>,
      <code><a href="pyactivemq.Message-class.html#getDoubleProperty">getDoubleProperty</a></code>,
      <code><a href="pyactivemq.Message-class.html#getFloatProperty">getFloatProperty</a></code>,
      <code><a href="pyactivemq.Message-class.html#getIntProperty">getIntProperty</a></code>,
      <code><a href="pyactivemq.Message-class.html#getLongProperty">getLongProperty</a></code>,
      <code><a href="pyactivemq.Message-class.html#getShortProperty">getShortProperty</a></code>,
      <code><a href="pyactivemq.Message-class.html#getStringProperty">getStringProperty</a></code>,
      <code><a href="pyactivemq.Message-class.html#propertyExists">propertyExists</a></code>,
      <code><a href="pyactivemq.Message-class.html#setBooleanProperty">setBooleanProperty</a></code>,
      <code><a href="pyactivemq.Message-class.html#setByteProperty">setByteProperty</a></code>,
      <code><a href="pyactivemq.Message-class.html#setDoubleProperty">setDoubleProperty</a></code>,
      <code><a href="pyactivemq.Message-class.html#setFloatProperty">setFloatProperty</a></code>,
      <code><a href="pyactivemq.Message-class.html#setIntProperty">setIntProperty</a></code>,
      <code><a href="pyactivemq.Message-class.html#setLongProperty">setLongProperty</a></code>,
      <code><a href="pyactivemq.Message-class.html#setShortProperty">setShortProperty</a></code>,
      <code><a href="pyactivemq.Message-class.html#setStringProperty">setStringProperty</a></code>
      </p>
    <p class="indent-wrapped-lines"><b>Inherited from <code><i>unreachable</i>.instance</code></b>:
      <code>__new__</code>
      </p>
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
      <code>__delattr__</code>,
      <code>__getattribute__</code>,
      <code>__hash__</code>,
      <code>__reduce__</code>,
      <code>__reduce_ex__</code>,
      <code>__repr__</code>,
      <code>__setattr__</code>,
      <code>__str__</code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== PROPERTIES ==================== -->
<a name="section-Properties"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Properties</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-Properties"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="pyactivemq.BytesMessage-class.html#bodyBytes" class="summary-name">bodyBytes</a><br />
      Return the bytes that are contained in this message.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="pyactivemq.BytesMessage-class.html#bodyLength" class="summary-name">bodyLength</a><br />
      Returns the number of bytes contained in the body of this message.
    </td>
  </tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="pyactivemq.Message-class.html">Message</a></code></b>:
      <code><a href="pyactivemq.Message-class.html#correlationID">correlationID</a></code>,
      <code><a href="pyactivemq.Message-class.html#deliveryMode">deliveryMode</a></code>,
      <code><a href="pyactivemq.Message-class.html#destination">destination</a></code>,
      <code><a href="pyactivemq.Message-class.html#expiration">expiration</a></code>,
      <code><a href="pyactivemq.Message-class.html#messageID">messageID</a></code>,
      <code><a href="pyactivemq.Message-class.html#priority">priority</a></code>,
      <code><a href="pyactivemq.Message-class.html#propertyNames">propertyNames</a></code>,
      <code><a href="pyactivemq.Message-class.html#redelivered">redelivered</a></code>,
      <code><a href="pyactivemq.Message-class.html#replyTo">replyTo</a></code>,
      <code><a href="pyactivemq.Message-class.html#timestamp">timestamp</a></code>,
      <code><a href="pyactivemq.Message-class.html#type">type</a></code>
      </p>
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
      <code>__class__</code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Method Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-MethodDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="readBoolean"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">readBoolean</span>(<span class="sig-arg">...</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    >&nbsp;
    </td>
  </tr></table>
  
  <pre class="literalblock">
Reads a boolean from the bytes message stream.
C++ signature:
    readBoolean(cms::BytesMessage {lvalue}) -&gt; bool

</pre>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="readByte"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">readByte</span>(<span class="sig-arg">...</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    >&nbsp;
    </td>
  </tr></table>
  
  <pre class="literalblock">
Reads a byte from the bytes message stream.
C++ signature:
    readByte(cms::BytesMessage {lvalue}) -&gt; unsigned char

</pre>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="readBytes"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">readBytes</span>(<span class="sig-arg">...</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    >&nbsp;
    </td>
  </tr></table>
  
  <pre class="literalblock">
Reads a byte array from the bytes message stream.

If the length of the vector value is less than the number of bytes remaining to be read from the stream, the vector should be filled. A subsequent call reads the next increment, and so on.

If the number of bytes remaining in the stream is less than the length of vector value, the bytes should be read into the vector. The return value of the total number of bytes read will be less than the length of the vector, indicating that there are no more bytes left to be read from the stream. The next read of the stream returns -1.
C++ signature:
    readBytes(cms::BytesMessage {lvalue}) -&gt; std::string

</pre>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="readChar"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">readChar</span>(<span class="sig-arg">...</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    >&nbsp;
    </td>
  </tr></table>
  
  <pre class="literalblock">
Reads a char from the bytes message stream.
C++ signature:
    readChar(cms::BytesMessage {lvalue}) -&gt; char

</pre>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="readDouble"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">readDouble</span>(<span class="sig-arg">...</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    >&nbsp;
    </td>
  </tr></table>
  
  <pre class="literalblock">
Reads a 64 bit double from the bytes message stream.
C++ signature:
    readDouble(cms::BytesMessage {lvalue}) -&gt; double

</pre>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="readFloat"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">readFloat</span>(<span class="sig-arg">...</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    >&nbsp;
    </td>
  </tr></table>
  
  <pre class="literalblock">
Reads a 32 bit float from the bytes message stream.
C++ signature:
    readFloat(cms::BytesMessage {lvalue}) -&gt; float

</pre>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="readInt"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">readInt</span>(<span class="sig-arg">...</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    >&nbsp;
    </td>
  </tr></table>
  
  <pre class="literalblock">
Reads a 32 bit signed integer from the bytes message stream.
C++ signature:
    readInt(cms::BytesMessage {lvalue}) -&gt; int

</pre>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="readLong"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">readLong</span>(<span class="sig-arg">...</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    >&nbsp;
    </td>
  </tr></table>
  
  <pre class="literalblock">
Reads a 64 bit long from the bytes message stream.
C++ signature:
    readLong(cms::BytesMessage {lvalue}) -&gt; long long

</pre>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="readShort"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">readShort</span>(<span class="sig-arg">...</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    >&nbsp;
    </td>
  </tr></table>
  
  <pre class="literalblock">
Reads a 16 bit signed short from the bytes message stream.
C++ signature:
    readShort(cms::BytesMessage {lvalue}) -&gt; short

</pre>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="readString"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">readString</span>(<span class="sig-arg">...</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    >&nbsp;
    </td>
  </tr></table>
  
  <pre class="literalblock">
Reads an ASCII string from the bytes message stream.
C++ signature:
    readString(cms::BytesMessage {lvalue}) -&gt; std::string

</pre>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="readUTF"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">readUTF</span>(<span class="sig-arg">...</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    >&nbsp;
    </td>
  </tr></table>
  
  <pre class="literalblock">
Reads an UTF string from the bytes message stream.
C++ signature:
    readUTF(cms::BytesMessage {lvalue}) -&gt; std::string

</pre>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="readUnsignedShort"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">readUnsignedShort</span>(<span class="sig-arg">...</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    >&nbsp;
    </td>
  </tr></table>
  
  <pre class="literalblock">
Reads a 16 bit unsigned short from the bytes message stream.
C++ signature:
    readUnsignedShort(cms::BytesMessage {lvalue}) -&gt; unsigned short

</pre>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="reset"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">reset</span>(<span class="sig-arg">...</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    >&nbsp;
    </td>
  </tr></table>
  
  <pre class="literalblock">
Puts the message body in read-only mode and repositions the stream of bytes to the beginning.
C++ signature:
    reset(cms::BytesMessage {lvalue}) -&gt; void*

</pre>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="writeBoolean"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">writeBoolean</span>(<span class="sig-arg">...</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    >&nbsp;
    </td>
  </tr></table>
  
  <pre class="literalblock">
Writes a boolean to the bytes message stream as a 1-byte value.

The value true is written as the value (byte)1; the value false is written as the value (byte)0.
C++ signature:
    writeBoolean(cms::BytesMessage {lvalue}, bool) -&gt; void*

</pre>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="writeByte"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">writeByte</span>(<span class="sig-arg">...</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    >&nbsp;
    </td>
  </tr></table>
  
  <pre class="literalblock">
Writes a byte to the bytes message stream as a 1-byte value.
C++ signature:
    writeByte(cms::BytesMessage {lvalue}, unsigned char) -&gt; void*

</pre>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="writeBytes"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">writeBytes</span>(<span class="sig-arg">...</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    >&nbsp;
    </td>
  </tr></table>
  
  <pre class="literalblock">
Writes a byte array to the bytes message stream using the vector size as the number of bytes to write.
C++ signature:
    writeBytes(cms::BytesMessage {lvalue}, std::string) -&gt; void*

</pre>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="writeChar"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">writeChar</span>(<span class="sig-arg">...</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    >&nbsp;
    </td>
  </tr></table>
  
  <pre class="literalblock">
Writes a char to the bytes message stream as a 1-byte value.
C++ signature:
    writeChar(cms::BytesMessage {lvalue}, char) -&gt; void*

</pre>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="writeDouble"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">writeDouble</span>(<span class="sig-arg">...</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    >&nbsp;
    </td>
  </tr></table>
  
  <pre class="literalblock">
Writes a double to the bytes message stream as a 8-byte value.
C++ signature:
    writeDouble(cms::BytesMessage {lvalue}, double) -&gt; void*

</pre>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="writeFloat"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">writeFloat</span>(<span class="sig-arg">...</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    >&nbsp;
    </td>
  </tr></table>
  
  <pre class="literalblock">
Writes a float to the bytes message stream as a 4-byte value.
C++ signature:
    writeFloat(cms::BytesMessage {lvalue}, float) -&gt; void*

</pre>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="writeInt"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">writeInt</span>(<span class="sig-arg">...</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    >&nbsp;
    </td>
  </tr></table>
  
  <pre class="literalblock">
Writes a signed integer to the bytes message stream as a 4-byte value.
C++ signature:
    writeInt(cms::BytesMessage {lvalue}, int) -&gt; void*

</pre>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="writeLong"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">writeLong</span>(<span class="sig-arg">...</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    >&nbsp;
    </td>
  </tr></table>
  
  <pre class="literalblock">
Writes a long to the bytes message stream as a 8-byte value.
C++ signature:
    writeLong(cms::BytesMessage {lvalue}, long long) -&gt; void*

</pre>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="writeShort"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">writeShort</span>(<span class="sig-arg">...</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    >&nbsp;
    </td>
  </tr></table>
  
  <pre class="literalblock">
Writes a signed short to the bytes message stream as a 2-byte value.
C++ signature:
    writeShort(cms::BytesMessage {lvalue}, short) -&gt; void*

</pre>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="writeString"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">writeString</span>(<span class="sig-arg">...</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    >&nbsp;
    </td>
  </tr></table>
  
  <pre class="literalblock">
Writes an ASCII string to the bytes message stream.
C++ signature:
    writeString(cms::BytesMessage {lvalue}, std::string) -&gt; void*

</pre>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="writeUTF"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">writeUTF</span>(<span class="sig-arg">...</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    >&nbsp;
    </td>
  </tr></table>
  
  <pre class="literalblock">
Writes an UTF string to the bytes message stream.
C++ signature:
    writeUTF(cms::BytesMessage {lvalue}, std::string) -&gt; void*

</pre>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="writeUnsignedShort"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">writeUnsignedShort</span>(<span class="sig-arg">...</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    >&nbsp;
    </td>
  </tr></table>
  
  <pre class="literalblock">
Writes a unsigned short to the bytes message stream as a 2-byte value.
C++ signature:
    writeUnsignedShort(cms::BytesMessage {lvalue}, unsigned short) -&gt; void*

</pre>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== PROPERTY DETAILS ==================== -->
<a name="section-PropertyDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Property Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-PropertyDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="bodyBytes"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">bodyBytes</h3>
  <p>Return the bytes that are contained in this message. Users should copy
  this data into a user allocated buffer.</p>
  <p>Check <a href="pyactivemq.BytesMessage-class.html#bodyLength" 
  class="link">bodyLength</a> to determine the number of bytes to 
  expect.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>(<span class="summary-sig-arg">...</span>)</span>
    </dd>
    <dt>Set Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>(<span class="summary-sig-arg">...</span>)</span>
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="bodyLength"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">bodyLength</h3>
  <p>Returns the number of bytes contained in the body of this message.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>(<span class="summary-sig-arg">...</span>)</span>
    </dd>
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="pyactivemq-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

      <th class="navbar" width="100%"></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Sat Sep 20 01:50:41 2008
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
